home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 081 / xrobot.arc / XR.DOC next >
Text File  |  1988-03-20  |  14KB  |  373 lines
  1.  
  2.       
  3.  
  4.                              XRobot Version 1.94
  5.  
  6.                                March 20, 1988
  7.  
  8.          Copyright 1988 InterZone Software Inc. All rights reserved.
  9.  
  10.  
  11.                   Available from FidoNet(Tm) node 1:135/20
  12.                              INTL-(305)-387-1135
  13.                     Operating 24 hrs at 300/1200/2400bps
  14.  
  15.  
  16.                   Suggestions welcome --- Complaints > NUL
  17.  
  18.                     "It's just another brick in the wall"
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                    The Advanced FidoNet(Tm) mail utility              
  61.  
  62.  
  63.  
  64.          XRobot                  User Manual                  Page   1
  65.  
  66.  
  67.          This is XRobot, the advanced automatic FidoNet(tm) compatible 
  68.          mail utility.  If you are  a  user  of  XRobot  you  may  not
  69.          recognize this version or at least not very much.  It has had 
  70.          a  face  lift  (someone said 'beyond recognition').  The main
  71.          concept is still there.  To provide you with a  powerful  and
  72.          easy to use 'ROBOT' utility.  
  73.  
  74.          A  robot  utility  is  just what the name implies, an easy to
  75.          control utility to aid you in your daily  Sysop  chores.   It
  76.          will  simplify  tasks like sending multiple files to multiple
  77.          destinations and requesting files from other systems.   These
  78.          functions  can involve a lot of extra work if the program you
  79.          are using does not handle everything properly.  I assume  you
  80.          know enough about FidoNet(Tm) and terms involved with this to 
  81.          understand   some  'techie'  descriptions.   This  is  not  a
  82.          beginner's utility - it is easy to use, but it  does  require
  83.          some pre-knowledge about operating as a node in general.  
  84.  
  85.          The history of this program is quite long and credits are due 
  86.          to   several   people  who  gave  me  ideas  and  hints  (and
  87.          complaints).  It would take up too much space if  I  were  to
  88.          list  them  all  here.   One  individual should be named here
  89.          though, Mats Knuts, the Swedish network  host  at  2:501/107.
  90.          When  I  first started writing this program he came with alot
  91.          of suggestions  and  helped  be  squeeze  alot  of  bugs  and
  92.          'undocumented features' out of the program.  
  93.  
  94.          The  original  code was written in Turbo Pascal v3.01A.  This
  95.          version is written in TurboC and should perform  even  faster
  96.          than the early versions.  
  97.  
  98.          SKYDIVE!  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.                    The Advanced FidoNet(Tm) mail utility              
  123.  
  124.  
  125.  
  126.          XRobot                  User Manual                  Page   2
  127.  
  128.  
  129.          The  basic  functions  are  as  mentioned to send and request
  130.          files.  You can do this with several  options  and  different
  131.          type   of  addressing  methods.   Earlier  versions  of  this
  132.          programs did not  support  anything  but  direct  addressing.
  133.          Most  of  the  data  is taken from a file referred to as 'the
  134.          control file' (or CTL file hereafter) which is where you will 
  135.          put your FidoNet(Tm) information  as  well  as  some  default
  136.          setting  you  wish  the  program  to  use  if nothing else is
  137.          specified.  
  138.  
  139.  
  140.          The CTL file 
  141.  
  142.          This file is a plain vanilla  ASCII  (text)  file.   You  can
  143.          create  it  with  your  text editor or word processor; or use
  144.          Edlin (the line editor) in DOS.  If  you  are  using  a  word
  145.          processor,  just  make  sure no additional control characters
  146.          are inserted in the file since this could  make  the  program
  147.          operate  a  little strange (which you would probably notice).
  148.          The program will search for the CTL file (Xrobot.Ctl) in  the
  149.          current  directory  or  in  the  directory  specified  by the
  150.          environment variable XROBOT  (Use  the  DOS  command  SET  to
  151.          create  this).   The  environment  variable  will be searched
  152.          first so  if  you  have  one  specified  that  will  override
  153.          searching in the current directory.  There are a few commands 
  154.          you can put in here:  
  155.  
  156.          ZONE    This   is   your   zone   address  (USA=1,  Europe=2,
  157.                  Australia=3).  If you do not plan  on  using  the  /Z
  158.                  switch  (described  later)  you do not have to define
  159.                  this.  
  160.  
  161.          NET     This is your net address.  
  162.  
  163.          NODE    This is your node address.  
  164.  
  165.          POINT   Your point address if you operate as a point.  If you 
  166.                  have this set, you must also set the  above  NET  and
  167.                  NODE  settings,  this  does  not  define your own net
  168.                  address since you are a point (defined by  the  POINT
  169.                  statement) but your BOSS.  
  170.  
  171.          MAIL    Defines  the  DOS path (directory actually) where you
  172.                  have your  outgoing  and  incoming  messages  stored.
  173.                  This  is  where  messages created by the program will
  174.                  end up.   If  there  is  no  trailing  backslash  the
  175.                  program will automatically append one.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.                    The Advanced FidoNet(Tm) mail utility              
  185.  
  186.  
  187.  
  188.          XRobot                  User Manual                  Page   3
  189.  
  190.  
  191.          MSGBITS This  is  a quite complex command.  It specifies what
  192.                  message attributes you wish the  program  do  use  by
  193.                  default.   There  are four options available.  For an
  194.                  explanation of these, consult your FidoNet(Tm) mailer 
  195.                  documentation - the ones supported are  CRASH,  HOLD,
  196.                  PRIVATE  and  KILL/SENT.   You  can  only specify one
  197.                  parameter on each line.  So if you want two  of  them
  198.                  set,  you  will  have to use two lines (with the word
  199.                  MSGBITS as the first word on both of them).  
  200.  
  201.          For an example of how a CTL file can look, print or list  the
  202.          sample  Xrobot.Ctl  file included in this package.  There are
  203.          several options that you cannot specify in the CTL file,  but
  204.          give  as 'command line arguments' when you start the program.
  205.          Some of these are required and some are optional.  The syntax 
  206.          to use when invoking the program is described below.  
  207.  
  208.          XR <action> <filemask> [zz:]net/node [switches] 
  209.  
  210.          Where <action> must be either SEND if you want  to  send  the
  211.          matching  files  of  <filemask>  or GET if you want to make a
  212.          file request.  Note that if you are using the  GET  function,
  213.          the  file  mask  will  not  be expanded but used as a request
  214.          name.  
  215.  
  216.          The <filemask>  can  be  any  valid  DOS  path  specification
  217.          including  wildcards.   If  the string contains any wildcards
  218.          they will be expanded to matching files.  This is one of  the
  219.          powerful  functions  of  this  program.   Most  other 'ROBOT'
  220.          utilities does not expand this string - they leave it  up  to
  221.          the  mailer  when  it sends the message to expand it.  If you
  222.          have wildcards specified and the transmission is aborted  for
  223.          any  reason, the program will most likely send the same files
  224.          again at the next attempt.  
  225.  
  226.          Following after the file mask is a list of  nodes.   You  can
  227.          specify  as  many  as  30  destinations.   If you wish to use
  228.          international  addressing  (through  Zone  Gates)  you   must
  229.          specify a zone address as well for nodes you wish to use this 
  230.          method  with  (ie.  2:501/224 for node 224 in net 501 located
  231.          in zone 2).  Note that if the /Z (described later) option  is
  232.          not  specified,  no  Zone  Gate addressing will be done.  The
  233.          optional switches will now be described.  
  234.  
  235.          /C      This  will  force  the  CRASH  attribute  to  be  set
  236.                  regardless of your CTL file settings.  If you already 
  237.                  have  this option specified in your CTL file, nothing
  238.                  will happen (it will not toggle it).  
  239.  
  240.          /H      This  will  force  the  HOLD  attribute  to  be   set
  241.                  regardless  of your CTL file settings (look at the /C
  242.                  option description for more information).  
  243.  
  244.  
  245.  
  246.                    The Advanced FidoNet(Tm) mail utility              
  247.  
  248.  
  249.  
  250.          XRobot                  User Manual                  Page   4
  251.  
  252.          /K      This will force the KILL/SENT  attribute  to  be  set
  253.                  regardless  of your CTL file settings (look at the /C
  254.                  option description for more information).  
  255.  
  256.          /P      This will force  the  PRIVATE  attribute  to  be  set
  257.                  regardless  of your CTL file settings (look at the /C
  258.                  option description for more information).  
  259.  
  260.          /Z      This  forces  the  program   to   use   international
  261.                  addressing methods.  If any of the nodes specified as 
  262.                  receiver  of  the  message  has  got a zone specified
  263.                  (other than yours and other than  zero)  the  message
  264.                  will  be  sent to your Zone Gate with an INTL line in
  265.                  the message body telling the Zone Gate software where 
  266.                  to send the message.  
  267.  
  268.          /T      Followed by a file name (ie.  /T Letter.Txt) will put 
  269.                  the contents of the specified file into  the  message
  270.                  body.   If the file cannot be found, the program will
  271.                  abort.  
  272.  
  273.          /B      Followed by a numerical value (ie.  /B 6) will insert 
  274.                  a POINT command in the message body.  This  specifies
  275.                  that you wish to send the message to point 6.  
  276.  
  277.          /A      Attach  path.   Normally, the path you specified will
  278.                  be used to specify the path where the  file  will  be
  279.                  present  when  you  send it.  But the file may not be
  280.                  there yet, or it may not be available there yet.  You 
  281.                  can insert another path specifier  instead  by  using
  282.                  this command (ie.  /A C:\Mail\Outbound\).  
  283.  
  284.          /D      Followed  by a numercial value (ie.  /D 10) specifies
  285.                  that you  want  to  perform  the  function  known  as
  286.                  'update  mailing'.   This  means  that  any file that
  287.                  matches the filemask that has not been updated within 
  288.                  ten days will be ignored and not sent.  This  can  be
  289.                  very  useful  for  sending  out  updates if you are a
  290.                  Host, Hub or Region Coordinator.  
  291.  
  292.          This program is not shareware, public  domain  nor  freeware.
  293.          You  may  use  this  program and distribute it as much as you
  294.          want if 1) No fees are charged in any form  2)  The  complete
  295.          ARChive  is  distributed  containing  the  original files put
  296.          there by me.  
  297.  
  298.          Want the source code?  
  299.  
  300.          If there is anything you want to see added to this utility to 
  301.          make it more useful for you or anyone else - let me know, I'm 
  302.          open to any suggestion.  Maybe a username in the CTL file  or
  303.          the option to specify a label in a text file (or the standard 
  304.          CTL  file)  that  would  define  something to do - whatever -
  305.          throw it at me.  
  306.  
  307.  
  308.                    The Advanced FidoNet(Tm) mail utility              
  309.  
  310.  
  311.  
  312.          XRobot                  User Manual                  Page   5
  313.  
  314.          People using Opus(noTm) as a mailer - how about a Opus switch 
  315.          that will force the program into 'Hi-Tek' mode, creating Opus 
  316.          .REQ files instead?  With password support of course.  
  317.  
  318.          UPDATES 
  319.  
  320.          1.90    This was a major re-write of the  older  versions  of
  321.                  XRobot.   First  of  all, this version was written in
  322.                  TurboC (compare to older versions  written  in  Turbo
  323.                  Pascal)  which  gave  us  some  more speed.  Extended
  324.                  addressing was added, point and zone support.  
  325.  
  326.          1.91    Had some problems myself with the /D  switch  (update
  327.                  mailing)  and it took a few hours to realize what was
  328.                  wrong with it..  but it has been fixed and should now 
  329.                  work properly.  
  330.  
  331.          1.92    Found  a  few  annoying   'unimplemented   features'.
  332.                  Changed some logics around.  Nothing really major.  
  333.  
  334.          1.93    Some  memory management code was cleaned up.  Changed
  335.                  compiler to TurboC 1.5.  
  336.  
  337.          1.94    Several FidoNet compatible mailer programs  have  the
  338.                  option  to delete "null" messages (ie.  messages with
  339.                  no text).  Since the program inserted a line  in  the
  340.                  message text, this feature didn't work.  The "Xrobot" 
  341.                  signature  now  appears  in  the  "from"  name of the
  342.                  message instead.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.                    The Advanced FidoNet(Tm) mail utility              
  371.  
  372.  
  373.